一套满足企业自建OpenAPI、接口平台的解决方案、产品和源代码

在现代软件系统项目开发中，API接口是不可或缺的组成部分。

不管是内部系统之间的接口调用和提供，还是外部API接口的对接和开发，搭建企业自己统一的接口平台，对API接口的开发、管理和维护，都会大有裨益。

例如以下几个接口平台的例子。

分类1：专门以提供API接口服务为主的服务市场，例如：聚合数据平台。在平台上会聚合提供不同分类的接口服务，每个接口有调用次数和不同的价格。这类平台，主要针对API接口调用次数收费。

分类2：聚焦于某个细分领域或行业数据服务的接口服务平台，并以API接口提供增值或主要服务。例如：查快递的快递100平台。此类平台以领域服务为主，同时以API为主要形式提供和对接。

分类3：由ISV提供的，面向开发者生态的接口平台。例如：我们所熟悉的抖音开放平台、微博开放平台、支付宝开放平台、微信小程序开放平台。此类平台，通常对接口的调用是免费的，不直接收到接口调用的服务费，但会分配不同的接口权限和每日接口配额。

分类4：在企业和企业之前，有针对性的开放部分API接口的平台。例如在学校系统或医院系统中，当需要提供API接口给指定企业、单位使用的，要么是直接提供数据库账号密码、要么创建提供视图、要么简单封装几个API接口。但都缺少规划和管理。我们暂且把这类在局域网或内网有针对性开放API接口的平台，称为内部接口平台。这些API接口，只对于某些单位才是有价值的。例如：YesDev协作云为程序员客栈这个渠道提供的专用API接口。同样有接口列表、接口在线文档。

分类5：自主研发的互联网产品的API接口平台，以供多端接入和使用。例如同一个产品矩阵，提供API接口给自己的安卓客户端、iOS客户端、小程序、H5、硬件设备等使用。

从上面的接口平台分类和例子，可以看出，如果没有一套完整的API接口平台，不管是面向外部的合作方、开发者，还是内部的产品和终端，都会容易失去对API开发、升级、维护和管理的能力。

有了统一的API接口平台，不管对内还是对外，都能更好做到：统一接口开发、统一接口管理、统一接口开放服务。

统一接口开发：包括API接口的命名、分类、格式、接口文档、接口变更记录、接口发布、接口测试、接口日记等，都要统一风格、规范标准和约束。

统一接口管理：包括API接口的升级、增加参数、部署、性能监控、错误日记，同时结合开发、测试、运维、文档等形成整套的研发体系和闭环。

统一接口开放服务：主要是针对接口的IP白名单、接口申请、接口调用权限、接口次数限制、接口流量统计，以及开发者账号的开通注册，以应用的创建和审核。解决要不要对接口收费，怎么收费和进行服务、售后支持。

接口大师，即 PhalApi Pro 专业版，是一套研发、管理和开放API接口的软件源代码和解决方案。

接口大师，针对API接口平台，提供了5合1的快速开发能力。分别有：

展示首页（游客访问）、Admin管理后台（管理员使用）、Platform开放平台（开发者使用）、Docs在线接口文档（100%全自动根据代码生成）、Wiki技术文档（二次开发完整的技术文档）。

我们分别通过三种不同的角色视角来体验和使用接口平台，以构成一个完整的业务流程。

角色1：开发者 - 使用方

首先，接口平台的最终使用人员是开发者，即具备开发能力的技术人员。他们需要使用你提供的API接口时，需要按以下流程来使用。

简单来说，开发者需要先注册一个自己的开发者账号，然后登录开放平台。

然后创建并申请自己的开发应用，并等待后台审核。因为最终调用API接口的是应用程序，不是开发者本人。

开发者应用审核通过后，就可以先调用接口获得访问的令牌access_token，最后就可以根据令牌使用他需要调用的API接口。

例如，汉字转拼音接口的在线接口文档（整份在线接口文档都是不需要再人工额外维护的，都是根据源代码自动生成，模板可以自己再调整）。还可以在线测试接口，不需要额外的接口测试工具。

最后，开发者还可以查看自己调用和使用接口的流量，以及查看自己拥有哪些API接口的权限等。

角色2：管理员 - 内部管理维护（此部分不需要开发，不需要技术人员）

再来看下，在这背后，为了让有需要用到你API接口的开发人者顺利调用接口，内部管理人员需要做哪些操作，以及可以怎么管理开发者账号、开发者的应用和开发者的接口权限。

首先，要以管理员的账号登录管理后台（为了方便区分，管理后台是黄色，开放平台是蓝色）。

进入管理后台，针对未审核的应用，进行审核。

你可以通过，也可以审核不通过。审核不通过的应用，是没有任何API接口的权限。

在此之前，你可能还要对所拥有的API接口进行权限分配。例如哪些开发者账号角色有哪些接口权限，或者哪些指定的开发者账号有哪些API权限，又或者是哪个应用有API权限。这些API接口权限，都可以进行灵活地配置。

甚至对开发者角色也是支持动态配置的。（PS：开发者在注册时，可以选择自己的类型。）

如果你需要对应用的调用IP地址进行限制，或者对应用的有效日期进行限制，或者是限制应用每天调用接口的总次数等，都可以在应用中进行设置。还包括有：重置app密钥等。

如果你需要对某些API接口设置收费套餐，例如调用多少次多少费用多久时间内有效。同时，还可以设置接口的免费试用次数等，以及组合优惠套餐。

设置好后，开发者就可以进行在线购买和使用，以及进行流量计费。

当然，你在管理后台，可以看到实时的接口流量，分为：全部接口次数、付费接口次数、试用接口次数、普通接口次数、扣费失败的次数等统计数据，方便你可以更好地进行日常运营和经营服务。

除此之外，你也可以看到接口流量订单、接口流量包套餐的列表和管理。

角色3：API接口开发 - 内部二次开发

看完了“台前”，我们再来看下“幕后”。

回归到技术层面，开发者在调用API接口前，管理员在维护API接口前，需要有内部技术人员开发API接口，并放到接口平台上。

接口大师提供了两种快速开发API接口的方案。一种是：API低代码接口开发；另一种是：PHP接口源代码开发。

先来说第一种，API低代码接口开发。

这种方式，基本可以完全通过管理后台的界面来完成，由非技术人员和非PHP开发工程师也能胜任和快速使用。

进入管理后台-接口管理-可视化接口设计。你可以看到之前通过后台开发过的API接口，可以重新编辑。

你可以快速创建一个新API接口，它的神奇之处在于，你可以通过页面表单的方式，快速生成API接口代码骨架和API源代码，甚至可以直接使用。同时，剩下的API接口文档、接口权限、接口统计、接口日记、接口发布，都不需要你再操心。

接口大师提供了三种生成API接口的类型：接口对接类的API、数据库接口API、普通接口API。

例如，假设你原来有一套内部的Java接口，可以快速嫁接到接口平台。填写好必要的接口参数，就可以点击【生成】API接口代码，没问题，保存发布，即可使用。

这里的接口模板是（你也可以自己调整）：